/*
 * Copyright 2018-present Open Networking Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.onosproject.workflow.api;

import com.fasterxml.jackson.databind.JsonNode;

/**
 * Interface for workflow RPC description.
 */
public interface RpcDescription {

    /**
     * Workflow RPC operation pointer.
     */
    String RPC_OP_PTR = "/op";

    /**
     * Workflow RPC parameters pointer.
     */
    String RPC_PARAMS_PTR = "/params";

    /**
     * Workflow RPC invocation ID pointer.
     */
    String RPC_ID_PTR = "/id";

    /**
     * Returns workflow RPC operation.
     * @return workflow RPC operation
     */
    String op();

    /**
     * Returns workflow RPC parameters.
     * @return workflow RPC parameters
     */
    JsonNode params();

    /**
     * Returns workflow RPC invocation ID.
     * @return workflow RPC invocation ID
     */
    String id();
}
